/* -*-c++-*- */
/* osgGIS - GIS Library for OpenSceneGraph
 * Copyright 2007-2008 Glenn Waldron and Pelican Ventures, Inc.
 * http://osggis.org
 *
 * osgGIS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 */

#ifndef _OSGGIS_RANDOM_GROUPING_FILTER_H_
#define _OSGGIS_RANDOM_GROUPING_FILTER_H_ 1

#include <osgGIS/Common>
#include <osgGIS/CollectionFilter>

namespace osgGIS
{
    /* (deprecated)
     * DEPRECATED - use GroupFilter with randomizing script instead
     *
     * A filter that randomly batches features into a set number of groups.
     *
     * This filter will eventually be deprecated in favor of a scripting-
     * language grouping filter that supports a "random" function.
     */
    class OSGGIS_EXPORT RandomGroupingFilter : public CollectionFilter
    {
        OSGGIS_META_FILTER( RandomGroupingFilter );  

    public:
        RandomGroupingFilter();

        RandomGroupingFilter( const RandomGroupingFilter& rhs );

        RandomGroupingFilter( int num_groups );


    public: // properties

        void setNumGroups( int value );
        int getNumGroups() const;

        void setSeed( int value );
        int getSeed() const;
    
    public:

        virtual void setProperty( const Property& prop );
        virtual Properties getProperties() const;
        
    public:
    
        virtual std::string assign( Feature*, FilterEnv* env );
        virtual std::string assign( osg::Drawable*, FilterEnv* env );
        virtual std::string assign( osg::Node*, FilterEnv* env );

    public:

        virtual ~RandomGroupingFilter();

    private:
        
        int num_groups;
        int seed;
    };
}


#endif // _OSGGIS_RANDOM_GROUPING_FILTER_H_
